<!DOCTYPE html>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" class="_Skins_HTML5___Top_Navigation" lang="en-us" xml:lang="en-us" data-mc-search-type="Stem" data-mc-help-system-file-name="Default.xml" data-mc-path-to-help-system="../../" data-mc-has-content-body="True" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic;Default" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="[%=System.LinkedTitle%]">
    <head>
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <meta charset="utf-8" />
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <link href="../../Skins/Default/Stylesheets/Slideshow.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Default/Stylesheets/Components/Styles.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Default/Stylesheets/Components/Tablet.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Default/Stylesheets/Components/Mobile.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Fluid/Stylesheets/foundation.6.2.3.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Fluid/Stylesheets/Styles.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Fluid/Stylesheets/Tablet.css" rel="stylesheet" type="text/css" data-mc-generated="True" />
        <link href="../../Skins/Fluid/Stylesheets/Mobile.css" rel="stylesheet" type="text/css" data-mc-generated="True" /><title>user Command</title>
        <link href="../Resources/TableStyles/TableStyle.css" rel="stylesheet" data-mc-stylesheet-type="table" />
        <link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" type="text/css" />
        <script src="../../Resources/Scripts/custom.modernizr.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/jquery.min.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/require.min.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/require.config.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/foundation.6.2.3_custom.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/plugins.min.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapGlobal.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapDom.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapUtilities.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapXhr.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapTextEffects.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapSlideshow.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapFeedback.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapDefault.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapHelpSystem.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapToc.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapToc.Breadcrumbs.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapToc.MiniToc.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapToc.SideMenu.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapIndex.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapGlossary.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapParser.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapSearch.js" type="text/javascript">
        </script>
        <script src="../../Resources/Scripts/MadCapTopic.js" type="text/javascript">
        </script>
    </head>
    <body>
        <div class="foundation-wrap off-canvas-wrapper">
            <div class="off-canvas-wrapper-inner" data-off-canvas-wrapper="">
                <aside class="off-canvas position-left" id="offCanvas" data-off-canvas="" data-position="left" data-mc-ignore="true">
                    <ul class="off-canvas-drilldown vertical menu off-canvas-list" data-drilldown="" data-mc-back-link="Back" data-mc-css-tree-node-expanded="is-drilldown-submenu-parent" data-mc-css-tree-node-collapsed="is-drilldown-submenu-parent" data-mc-css-sub-menu="vertical menu slide-in-left is-drilldown-submenu" data-mc-include-indicator="False" data-mc-include-icon="False" data-mc-include-parent-link="True" data-mc-include-back="True" data-mc-defer-expand-event="True" data-mc-expand-event="click.zf.drilldown" data-mc-toc="True">
                    </ul>
                </aside>
                <div class="off-canvas-content inner-wrap" data-off-canvas-content="">
                    <div data-sticky-container="" class="title-bar-container">
                        <nav class="title-bar tab-bar sticky" data-sticky="" data-options="marginTop:0" style="width:100%" data-sticky-on="only screen and (max-width: 1000px)" data-mc-ignore="true">
                            <div class="middle title-bar-section outer-row clearfix">
                                <div class="menu-icon-container relative clearfix">
                                    <button class="menu-icon" data-toggle="offCanvas"><span></span>
                                    </button>
                                </div>
                            </div>
                            <div class="title-bar-layout outer-row">
                                <div class="logo-wrapper"><a class="logo" href="index.htm" alt="Logo"></a>
                                </div>
                                <div class="navigation-wrapper nocontent">
                                    <ul class="navigation clearfix" data-mc-css-tree-node-has-children="has-children" data-mc-css-sub-menu="sub-menu" data-mc-expand-event="mouseenter" data-mc-top-nav-menu="True" data-mc-max-depth="3" data-mc-include-icon="False" data-mc-include-indicator="False" data-mc-include-children="True" data-mc-include-siblings="True" data-mc-include-parent="True" data-mc-toc="True">
                                        <li class="placeholder" style="visibility:hidden"><a>placeholder</a>
                                        </li>
                                    </ul>
                                </div>
                                <div class="nav-search-wrapper">
                                    <div class="nav-search row">
                                        <form class="search" action="#">
                                            <div class="search-bar search-bar-container needs-pie">
                                                <input class="search-field needs-pie" type="search" placeholder="Search" />
                                                <div class="search-filter-wrapper">
                                                    <div class="search-filter">
                                                        <div class="search-filter-content">
                                                            <ul>
                                                                <li>All Files</li>
                                                            </ul>
                                                        </div>
                                                    </div>
                                                </div>
                                                <div class="search-submit-wrapper" dir="ltr">
                                                    <div class="search-submit" title="Search">
                                                    </div>
                                                </div>
                                            </div>
                                        </form>
                                    </div>
                                </div>
                            </div>
                        </nav>
                    </div>
                    <section class="main-section">
                        <div class="row outer-row sidenav-layout">
                            <div class="sidenav-wrapper">
                                <div class="sidenav-container">
                                    <ul class="off-canvas-accordion vertical menu sidenav" data-accordion-menu="" data-mc-css-tree-node-expanded="is-accordion-submenu-parent" data-mc-css-tree-node-collapsed="is-accordion-submenu-parent" data-mc-css-sub-menu="vertical menu accordion-menu is-accordion-submenu nested" data-mc-include-indicator="False" data-mc-include-icon="False" data-mc-include-parent-link="False" data-mc-include-back="False" data-mc-defer-expand-event="True" data-mc-expand-event="click.zf.accordionMenu" data-mc-toc="True" data-mc-side-nav-menu="True">
                                    </ul>
                                </div>
                            </div>
                            <div class="body-container" data-mc-content-body="True">
                                <h1>user Command</h1>
                                <p>Use this command to create, delete, and manage users.</p>
                                <ul>
                                    <li value="1"><a href="#create">create Subcommand</a>
                                    </li>
                                    <li value="2"><a href="#delete">delete Subcommand</a>
                                    </li>
                                    <li value="3"><a href="#list">list Subcommand</a>
                                    </li>
                                </ul>
                                <h2><a name="create"></a>create Subcommand</h2>
                                <h3>Synopsis</h3>
                                <p>Creates and initializes a new Nauta user. This command must be executed when kubectl is used by a nctl command entered by a k8s administrator. If this command is executed by someone other than a k8s administrator, it fails. By default this command saves a configuration of a newly created user to a file. The format of this file is compliant with a format of kubectl configuration files.</p>
                                <h3>Syntax</h3>
                                <p><span style="font-family: 'Courier New';">nctl user create [options] USERNAME</span>
                                </p>
                                <h3>Arguments</h3>
                                <table style="width: 100%;mc-table-style: url('../Resources/TableStyles/TableStyle.css');" class="TableStyle-TableStyle" cellspacing="3">
                                    <col style="width: 210px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 152px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 654px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <tbody>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Name </th>
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Required</th>
                                            <th class="TableStyle-TableStyle-BodyD-Column1-Body1">Description</th>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyB-Column1-Body1" style="font-family: 'Courier New';">USERNAME</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyB-Column1-Body1">Yes</td>
                                            <td class="TableStyle-TableStyle-BodyA-Column1-Body1">Name of a user that will be created. This value must a valid OS level user.</td>
                                        </tr>
                                    </tbody>
                                </table>
                                <p><![CDATA[	]]></p>
                                <h3>Options</h3>
                                <table style="width: 100%;mc-table-style: url('../Resources/TableStyles/TableStyle.css');" class="TableStyle-TableStyle" cellspacing="3">
                                    <col style="width: 210px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 152px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 654px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <tbody>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Name </th>
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Required</th>
                                            <th class="TableStyle-TableStyle-BodyD-Column1-Body1">Description</th>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyE-Column1-Body1" style="font-family: 'Courier New';">-l, --list_only</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyE-Column1-Body1">	No</td>
                                            <td class="TableStyle-TableStyle-BodyD-Column1-Body1">If given, content of the generated user's config file is displayed on the screen only. <br />If not given, the file with configuration is saved on disk.</td>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyE-Column1-Body1" style="font-family: 'Courier New';">-f, --filename &lt;filename&gt; TEXT</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyE-Column1-Body1">No</td>
                                            <td class="TableStyle-TableStyle-BodyD-Column1-Body1">Name of file where user's configuration will be stored. If not given configuration is stored in the <span style="font-family: 'Courier New';">config.&lt;username&gt;</span> file.</td>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyE-Column1-Body1" style="font-family: 'Courier New';">-v, --verbose</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyE-Column1-Body1">No</td>
                                            <td class="TableStyle-TableStyle-BodyD-Column1-Body1">Set verbosity level:<br /> -v for INFO<br />-vv for DEBUG<br /></td>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyB-Column1-Body1" style="font-family: 'Courier New';">-h, --help </td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyB-Column1-Body1">No</td>
                                            <td class="TableStyle-TableStyle-BodyA-Column1-Body1">Show help message and exit.</td>
                                        </tr>
                                    </tbody>
                                </table>
                                <p>&#160;</p>
                                <h3>Additional remarks</h3>
                                <p>In case of any errors during saving of a file with a configuration, the command displays a content of the configuration file on the screen, even if -l option wasn't used.</p>
                                <p>If an admin tries to create a user with a name that was used previously by a deleted user, it may happen, that the create command displays information that the previous user is still being deleted, even if the previous user is not listed on a list of existing users. In this case the operation of a creation of a new user should be postponed for a while until all user's objects are removed.</p>
                                <h3>Returns</h3>
                                <p>In case of any problems, a message is displayed describing their cause/causes. Otherwise message is returned indicating success. If <span style="font-family: 'Courier New';">--list_only</span> option was given, then the command displays also a content of a configuration file.</p>
                                <h3>Notes</h3>
                                <p>The user name must fulfill the following rules:</p>
                                <ol>
                                    <li value="1">Cannot be longer than 32 characters.</li>
                                    <li value="2">Cannot be an empty string.</li>
                                    <li value="3">Must conform to Kubernetes naming convention - can contain only lower case alphanumeric characters and "-" and "."</li>
                                </ol>
                                <p>&#160;</p>
                                <h3>Examples</h3>
                                <p><span style="font-family: 'Courier New';">nctl user create jdoe</span>
                                </p>
                                <p>Creates a jdoe user.</p>
                                <h2><a name="delete"></a>delete Subcommand</h2>
                                <h3>Synopsis</h3>
                                <p>Command deletes a user with a given name. If option -p/--purge was added, it removes also all artifacts related to a removed user, such as the content of the user's folders and data of experiments and runs.</p>
                                <h3>Syntax</h3>
                                <p><span style="font-family: 'Courier New';">nctl user delete USERNAME</span>
                                </p>
                                <h3>Arguments</h3>
                                <table style="width: 100%;mc-table-style: url('../Resources/TableStyles/TableStyle.css');" class="TableStyle-TableStyle" cellspacing="3">
                                    <col style="width: 210px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 152px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 654px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <tbody>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Name </th>
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Required</th>
                                            <th class="TableStyle-TableStyle-BodyD-Column1-Body1">Description</th>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyB-Column1-Body1" style="font-family: 'Courier New';">USERNAME</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyB-Column1-Body1">Yes</td>
                                            <td class="TableStyle-TableStyle-BodyA-Column1-Body1">Name of a user who should be removed from the system.</td>
                                        </tr>
                                    </tbody>
                                </table>
                                <p>&#160;</p>
                                <h3>Options</h3>
                                <table style="width: 100%;mc-table-style: url('../Resources/TableStyles/TableStyle.css');" class="TableStyle-TableStyle" cellspacing="3">
                                    <col style="width: 210px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 152px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 654px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <tbody>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Name </th>
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Required</th>
                                            <th class="TableStyle-TableStyle-BodyD-Column1-Body1">Description</th>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyE-Column1-Body1" style="font-family: 'Courier New';">-p, --purge</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyE-Column1-Body1">No	</td>
                                            <td class="TableStyle-TableStyle-BodyD-Column1-Body1">If set the system also removes all logs generated by the user's experiments.<br /></td>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyE-Column1-Body1" style="font-family: 'Courier New';">-v, --verbose</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyE-Column1-Body1">No</td>
                                            <td class="TableStyle-TableStyle-BodyD-Column1-Body1">Set verbosity level:<br /> -v for INFO<br />-vv for DEBUG<br /></td>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyB-Column1-Body1" style="font-family: 'Courier New';">-h, --help </td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyB-Column1-Body1">No</td>
                                            <td class="TableStyle-TableStyle-BodyA-Column1-Body1">Show help message and exit.</td>
                                        </tr>
                                    </tbody>
                                </table>
                                <p>&#160;</p>
                                <h3>Additional remarks</h3>
                                <p>Before removing a user, the commands asks for a final confirmation. If user chooses Yes, the user is deleted.</p>
                                <p>Deletion of a user may take a while to be fully completed. The command takes up to 30 seconds for complete removal of the user. If after this time user hasn't been deleted completely, the command displays information that a user is still being deleted. In this case the user won't be listed on a list of existing users but there is no possibility to create a user with the same name until the command completes and the user is deleted.</p>
                                <h3>	Returns</h3>
                                <p>A message about a result of the operation. In case of any problems, a short description of their causes.</p>
                                <h3>Examples</h3>
                                <p><span style="font-family: 'Courier New';">nctl user delete jdoe -p</span>
                                </p>
                                <p>Removes jdoe user with all his/her artifacts.</p>
                                <h2><a name="list"></a>list Subcommand</h2>
                                <h3>Synopsis</h3>
                                <p>Lists all currently configured users.</p>
                                <h2>Syntax</h2>
                                <p style="font-family: 'Courier New';">nctl user list [options]</p>
                                <h3>Options</h3>
                                <table style="width: 100%;mc-table-style: url('../Resources/TableStyles/TableStyle.css');" class="TableStyle-TableStyle" cellspacing="3">
                                    <col style="width: 210px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 152px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <col style="width: 654px;" class="TableStyle-TableStyle-Column-Column1" />
                                    <tbody>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Name </th>
                                            <th class="TableStyle-TableStyle-BodyE-Column1-Body1">Required</th>
                                            <th class="TableStyle-TableStyle-BodyD-Column1-Body1">Description</th>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyE-Column1-Body1" style="font-family: 'Courier New';">-c, --count<br />INTEGER&#160;RANGE</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyE-Column1-Body1">No	</td>
                                            <td class="TableStyle-TableStyle-BodyD-Column1-Body1">If given, the command displays c last rows.<br /></td>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyE-Column1-Body1" style="font-family: 'Courier New';">-v, --verbose</td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyE-Column1-Body1">No</td>
                                            <td class="TableStyle-TableStyle-BodyD-Column1-Body1">Set verbosity level:<br /> -v for INFO<br />-vv for DEBUG<br /></td>
                                        </tr>
                                        <tr class="TableStyle-TableStyle-Body-Body1">
                                            <td class="TableStyle-TableStyle-BodyB-Column1-Body1" style="font-family: 'Courier New';">-h, --help </td>
                                            <td style="text-align: center;" class="TableStyle-TableStyle-BodyB-Column1-Body1">No</td>
                                            <td class="TableStyle-TableStyle-BodyA-Column1-Body1">Show help message and exit.</td>
                                        </tr>
                                    </tbody>
                                </table>
                                <p>&#160;</p>
                            </div>
                        </div>
                    </section><a data-close="true"></a>
                </div>
            </div>
            <script>/* <![CDATA[ */$(document).foundation();/* ]]> */</script>
        </div>
    </body>
</html>